Skip to content

pr05 Typescript Migration #13: Migrate the User Model (& API Key schema) #3672

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 24 commits into from
Oct 3, 2025
Merged

pr05 Typescript Migration #13: Migrate the User Model (& API Key schema) #3672

merged 24 commits into from
Oct 3, 2025

Conversation

clairep94
Copy link
Collaborator

@clairep94 clairep94 commented Sep 27, 2025 •
edited
Loading

Migration of the user model to ts

  • made some assumptions/work arounds to solve type errors
  • This is a best effor, I will attempt the user controller next -- I expect that that attempt may result in tweaks to this file afterwards
    • I actually originally attempted to migrate the entire user system (controller, model, routes) but this was too difficult to do without previous PRs being finalised and merged. Please see here for that attempt
  • Added a test for the user model before migrating, so I could ensure nothing breaks
  • All tests pass & all typechecks pass

Changes:

  • Move apikey schema to its own file
  • Add test for user model
  • Extract types from user and api key
    • Note: my original approach was to use mongoose inferSchemaType and other infers but this was honestly really hard to debug and it was easier to explicity define what we expect from the types and feed it to the mongoose scheme definition, and attach the extra Document methods
  • Migrate apiKey and user to ts & to named export

I have verified that this pull request:

  • has no linting errors (npm run lint)
  • has no test errors (npm run test)
  • is from a uniquely-named feature branch and is up to date with the develop branch.
  • is descriptively named and links to an issue number, i.e. Fixes #123
  • meets the standards outlined in the accessibility guidelines

clairep94 and others added 23 commits September 25, 2025 23:34
@clairep94
eslint: turn off underscore-dangle warning
6d9fb34
@clairep94
install bcrypt type
dd4c6e6
@clairep94
server/types: add email confirmation states & user preferences
f10ae22
@clairep94
package.json reorder after re-install
f56509f
@clairep94
server/models: refactor apiKey to its own file & add test
2d37b08
@clairep94
model/user: add unit test for user model
0fc60bd
@clairep94
migrate to ts, no-verify
ae11dc8
@clairep94
apiKey: first attempt at defining types --no-verify
17455f5
@clairep94
apiKey: add working types
fc58c79
@clairep94
apiKey: migrate to separate types file
3baec8f
@clairep94
turn on strict null checks for mongoose infer
6bb876f
@clairep94
models/user: migrate to ts, no-verify
8c06deb
@clairep94
models/apiKey: re-implement in pattern from attempt 2 --no-verify
2be814f
@clairep94
model/user: test update to ts, no-verify
bb61e13
@clairep94
model/user: update user mock and resolve failing tests, no-verify
3746446
@clairep94
install sinon types, no-verify
000963d
@clairep94
models/user: update to named export, no-verify but tests pass
5f1efe8
@clairep94
models/user: resolve types using definitions from attempt 1 PR with t…
790ba5b 
…ests passing
@clairep94
models/user: attach EmailConfirmationStates via function call
0ebbf59
@clairep94
cleanup
9e121fd
@clairep94
update user model test to use mongodb-memory-server for passing on lo…
2d71fc7 
…cal and ci
@clairep94
nominal change to trigger ci
e453119
@clairep94
Merge branch 'develop' into pr05/migrate_user_model_finalattempt
a713de7
@clairep94 clairep94 marked this pull request as ready for review September 27, 2025 13:31
@clairep94 clairep94 changed the title Pr05/migrate user pr05 Typescript Migration #13: Migrate the User Model (& API Key schema) Sep 27, 2025
khanniie
khanniie previously approved these changes Sep 27, 2025
View reviewed changes
server/models/user.ts
lastLoginTimestamp: { type: Date }
},
{ timestamps: true, usePushEach: true }
{ timestamps: true }
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we don't need usePushEach anymore? is it set to that by default? just wanted to make sure it didn't slip through the cracks!

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for catching this! It was used for older mongo versions, and is no longer needed past v5, so i think we might be good here!

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi guys sorry for the delayed response! Yess once I migrated this file to ts, usePushEach was highlighting in red as it was deprecated for the current version of mongo, so I think we're meant to delete it

@clairep94 clairep94 added the pr05 Grant Projects pr05 Grant Projects label Oct 2, 2025
raclim
raclim approved these changes Oct 3, 2025
View reviewed changes
Copy link
Collaborator

@raclim raclim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Merging this in!

@raclim raclim merged commit 0ccfd0e into processing:develop Oct 3, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@raclim raclim raclim approved these changes

@khanniie khanniie khanniie left review comments

Assignees
No one assigned
Labels
pr05 Grant Projects pr05 Grant Projects
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@clairep94 @khanniie @raclim